home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / latex209 / contrib / picins / picins.txt < prev    next >
Text File  |  1994-08-09  |  4KB  |  113 lines
  1. % Summary of commands in picins.sty
  2. % This summary made by Piet van Oostrum <piet@cs.ruu.nl> 1994/08/03
  3. % NOTE: The author of picins.sty is Joachim Bleser (TH Darmstadt)
  4.  
  5. %    \parpic   : Text flows around picture
  6. %    \hpic      : Pictures in a separate paragraph
  7. %    \picskip  : directs the flow of text around pictures
  8. %    \pichskip : horizontal distance between picture and text
  9. %    \shadowthickness: obvious
  10. %    \dashlength: Length of dashes
  11. %    \boxlength:  depth of boxes
  12. %    \piccaption: Caption under/beside the picture
  13. %    \newcaption: enhanced \caption-command
  14. %    \picchangemode: directs picture placement
  15. %
  16. %    New environments:
  17. %    frameenv : frame around contents
  18. %    shadowenv: frame with shadow around contents
  19. %    ovalenv  : frame with rounded corners around contents
  20. %    dashenv  : dashed frame around contents
  21.  
  22. \parpic(width,height)(x-offset,y-offset)[Options][Position]{Picture}
  23. Paragraph text....
  24.  
  25. All parameters except the Picture are optional. The picture can be
  26. positioned left or right, boxed with a rectangle, oval, shadowbox,
  27. dashed box, a caption can be given which includes it in the List of
  28. figures.
  29.  
  30. If the width and height are not given [in which case also no offsets
  31. can be given] or if they are given as 0pt, the actual size of the
  32. Picture is used.
  33.  
  34. Options can be (default is l): 
  35.     l - put picture on left side of the paragraph
  36.     r - put picture on right side of the paragraph
  37.  
  38.     f - frame the picture
  39.     d - put a dashed frame aroud the picture
  40.     o - put an \oval around the picture
  41.     s - put a shadowbox around the picture
  42.     x - put a 3D box around the picture
  43.     Max one of each group can be given
  44.  
  45. Position:
  46.     l - put the picture left in the box
  47.     r - put the picture right in the box
  48.     t - put the picture in the top of the box
  49.     b - put the picture in the bottom of the box
  50.     Default is centering. It only makes a difference if the width and
  51.     height given are bigger than the actual picture. If offsets are
  52.     given Position is not used.
  53.  
  54. Picture can be any LaTeX construct.
  55.  
  56. \picskip{n} overrules the normal calculations about the number of lines
  57. that should be indented for the picture. By default the paragraph is
  58. indented until the end of the picture. If \picskip{n} is given, from
  59. this point on exactly n lines will be indented. \picskip terminates the
  60. currrent paragraph. It should NOT be followed by \par or an empty line.
  61.  
  62. \pichskip{length} defines the horizontal distance between picture and text.
  63.  
  64. \dashlength{length} defines the length of the dashes used in a dashed
  65. box (default 4pt). It is given as parameter to \dashbox.
  66.  
  67. \shadowthickness{length} defines the obvious thing for shadowboxes.
  68.  
  69. \boxlength{length} defines the depth of the 3D boxes (default 10pt).
  70.  
  71. \piccaption[]{Caption text} defines the caption for the picture. It must
  72. be given BEFORE the \parpic command. The parameters are as in the standard
  73. LaTeX \caption command. It makes a figure caption. You must change
  74. \@captype to get e.g. a table caption. The real caption is generated by the
  75. \parpic command, so a \label command should be given AFTER the \parpic command.
  76.  
  77. Placement:
  78. \piccaptionoutside causes the caption to be positioned below the
  79.     picture, outside of the box. (this is the default).
  80. \piccaptioninside  causes the caption to be positioned below the
  81.     picture, inside of the box.
  82. \piccaptionside positions the caption besides the picture (vertically
  83.     centered) 
  84. \piccaptiontopside positions the caption besides the picture (top
  85.     aligned)
  86.  
  87. \picchangemode causes the [l] and [r] Options of \parpic to be reversed
  88. on even pages, so that [l] means inside of the page, and [r] means
  89. outside of the page.
  90. \nopicchangemode cancels this effect.
  91.  
  92. \newcaption[Short]{Caption text} is like \caption, but formats a ``hanging''
  93. caption. If you want to combine this with \piccaption you should do a
  94. \let\caption\newcaption.
  95.  
  96. \hpic(width,height)(x-offset,y-offset)[Options][Position]{Picture}
  97. can be used to place pictures besides each other (each one should be
  98. included in a \hpic). You can e.g. put a number of \hpic's in a
  99. \centerline. 
  100.  
  101. Options can be:
  102.     t - align the pictures on top
  103.     b -  align the pictures on bottom
  104.     (default vertically centered)
  105.     t d o s x - as in \parpic
  106.  
  107. Framed environments:
  108. ct
  109. \begin{xxx}[width]
  110.     ....
  111. \end{xxx}
  112.     xxx can be frameenv, shadowenv, ovalenv or dashenv .
  113.